Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: introspection for bytes31 #2661

Merged
merged 1 commit into from
Nov 8, 2024
Merged

feat: introspection for bytes31 #2661

merged 1 commit into from
Nov 8, 2024

Conversation

shramee
Copy link
Contributor

@shramee shramee commented Nov 8, 2024

Description

Related issue

Tests

  • Yes
  • No, because they aren't needed
  • No, because I need help

Added to documentation?

  • README.md
  • Dojo Book
  • No documentation needed

Checklist

  • I've formatted my code (scripts/prettier.sh, scripts/rust_fmt.sh, scripts/cairo_fmt.sh)
  • I've linted my code (scripts/clippy.sh, scripts/docs.sh)
  • I've commented my code
  • I've requested a review after addressing the comments

Summary by CodeRabbit

  • New Features

    • Expanded the primitive type introspection to include the new type "bytes31" for enhanced type mapping.
  • Bug Fixes

    • No bug fixes were included in this release.
  • Documentation

    • Updated introspection output to reflect the addition of the new type.

Copy link

coderabbitai bot commented Nov 8, 2024

Walkthrough

Ohayo, sensei! This pull request introduces a new entry in the primitive_type_introspection function, adding the type "bytes31" with a corresponding TypeIntrospection value of (1, vec![248]). This enhancement expands the mapping of primitive types without altering existing logic or structure. The change enriches the output by including additional introspection information while keeping all other functionalities intact.

Changes

File Path Change Summary
crates/dojo/lang/src/derive_macros/introspect/utils.rs Added new entry for "bytes31" in primitive_type_introspection with value (1, vec![248]).

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Function
    participant Output

    User->>Function: Request primitive type introspection
    Function->>Output: Return mapping of primitive types
    Output-->>User: Includes "bytes31" with (1, vec![248])
Loading

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
crates/dojo/lang/src/derive_macros/introspect/utils.rs (1)

Line range hint 9-19: Consider documenting the introspection value selection.

The implementation uses TypeIntrospection(1, vec![248]) for bytes31, similar to how felt252 uses vec![251] and other numeric types use their bit sizes. It would be helpful to document why 248 was chosen for bytes31.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between ed12756 and 6e28b2d.

📒 Files selected for processing (1)
  • crates/dojo/lang/src/derive_macros/introspect/utils.rs (1 hunks)
🔇 Additional comments (1)
crates/dojo/lang/src/derive_macros/introspect/utils.rs (1)

9-9: Ohayo sensei! The bytes31 introspection implementation looks solid!

The implementation follows the established pattern for primitive types, using a TypeIntrospection with size 1 and a descriptor value of 248. This aligns well with other fixed-size types in the collection.

Let's verify the consistency of this implementation:

✅ Verification successful

Ohayo sensei! The bytes31 introspection implementation is perfectly aligned with the codebase patterns!

The implementation follows the established pattern where:

  • All primitive types use TypeIntrospection with size 1
  • The descriptor value 248 for bytes31 fits well in the sequence with other types
  • The placement in the HashMap is logical, grouped with other primitive types
  • The type is properly handled in bindgen plugins (typescript, unity, recs)
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that bytes31 isn't already handled elsewhere and check for related tests

# Check for any other bytes31 type handling
rg -i "bytes31" --type rust

# Look for related test cases
rg -i "test.*bytes31" --type rust

Length of output: 471


Script:

#!/bin/bash
# Let's verify the implementation pattern by checking other similar types

# Check the context around bytes31 implementation
rg -B 5 -A 5 "bytes31" crates/dojo/lang/src/derive_macros/introspect/utils.rs

# Look for other byte-related type implementations
ast-grep --pattern 'TypeIntrospection($_, vec![$_])'

Length of output: 1980

Copy link
Collaborator

@glihm glihm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a good catch, thank you @shramee for PRing it!

Copy link

codecov bot commented Nov 8, 2024

Codecov Report

Attention: Patch coverage is 0% with 1 line in your changes missing coverage. Please review.

Project coverage is 57.49%. Comparing base (ed12756) to head (6e28b2d).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
...es/dojo/lang/src/derive_macros/introspect/utils.rs 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2661      +/-   ##
==========================================
- Coverage   57.49%   57.49%   -0.01%     
==========================================
  Files         400      400              
  Lines       50276    50277       +1     
==========================================
  Hits        28905    28905              
- Misses      21371    21372       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@glihm glihm merged commit c7900e9 into dojoengine:main Nov 8, 2024
13 of 14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants